docs(task): add AI documentation for CallControl, IncomingTask, OutdialCall, TaskList widgets #577

ciscoRankush · 2025-12-11T12:51:57Z

COMPLETES N/A - Documentation Enhancement

This pull request addresses

Adding AI-optimized documentation for all task-related widgets to help AI assistants understand call handling and task management workflows.

by making the following changes

Added packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md and ARCHITECTURE.md
Added packages/contact-center/task/ai-docs/widgets/IncomingTask/AGENTS.md and ARCHITECTURE.md
Added packages/contact-center/task/ai-docs/widgets/OutdialCall/AGENTS.md and ARCHITECTURE.md
Added packages/contact-center/task/ai-docs/widgets/TaskList/AGENTS.md and ARCHITECTURE.md

Change Type

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Tooling change
Internal code refactor

The following scenarios were tested

The testing is done with the amplify link

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

I have not skipped any automated checks
All existing and new tests passed
I have updated the testing document
I have tested the functionality with amplify link

Make sure to have followed the contributing guidelines before submitting.

…alCall, TaskList widgets

aws-amplify-us-east-2 · 2025-12-11T13:05:20Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-577.d1b38q61t1z947.amplifyapp.com

Riteshfyi · 2026-01-13T13:13:51Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+
+## Props API
+
+| Prop | Type | Default | Description |


a common query regarding the methods listed below, all of the do not have the arguement {task} here but in the code they do, so let me know if it is done intentionally,

Thanks for catching this added the proper arguments

Riteshfyi · 2026-01-13T13:14:18Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `onHoldResume` | `(isHeld: boolean) => void` | - | Callback when hold state changes |


as per the code, the onHoldResume method has two input arguements, (isHeld : boolean , task : ITask).
here the task parameter is missing, do let me know if it is done intentionally.

Added the correct arguments

Riteshfyi · 2026-01-13T13:14:41Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+|------|------|---------|-------------|
+| `onHoldResume` | `(isHeld: boolean) => void` | - | Callback when hold state changes |
+| `onEnd` | `() => void` | - | Callback when call ends |
+| `onWrapUp` | `() => void` | - | Callback when wrapup completes |


onWrapUp({ task: currentTask, wrapUpReason: wrapUpReason, })

here the two parameters are missing

Added the correct arguments

Riteshfyi · 2026-01-13T13:15:21Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+- `TASK_RECORDING_PAUSED` - Recording paused
+- `TASK_RECORDING_RESUMED` - Recording resumed
+
+**Returns:** All functions and state for call control operations


are we not going to mention the returned functions and variables here?

No, the plan is that that information will come from the knowledge base of the sdk

Riteshfyi · 2026-01-13T13:15:37Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    U->>C: Click Transfer button
+    C->>C: Show transfer modal
+    U->>C: Select agent from list
+    C->>H: transferCall(agentId, name, 'AGENT')


In the Code, i am only able to see two parameters.
const transferCall = async (to: string, type: DestinationType)

Added the correct arguments

Riteshfyi · 2026-01-13T13:15:53Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    U->>C: Click Consult button
+    C->>C: Show consult modal
+    U->>C: Select agent
+    C->>H: consultCall(agentId, name, 'AGENT')


const consultCall = async (
consultDestination: string,
destinationType: DestinationType,
allowParticipantsToInteract: boolean
)

parameters not matching here, do let me know if it is done intentionally.

Added the correct arguments

Riteshfyi · 2026-01-13T13:16:14Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    U->>C: Click Conference button
+    C->>C: Show conference modal
+    U->>C: Select agent
+    C->>H: consultCall(agentId, name, 'AGENT')


here also the parameters are different from the one mentioned in the code

Added the correct arguments

Riteshfyi · 2026-01-13T13:16:26Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    C->>C: setSelectedWrapupReason(code)
+
+    U->>C: Click Submit Wrapup
+    C->>H: wrapupCall(reason, id, auxCode)


const wrapupCall = (wrapUpReason: string, auxCodeId: string)
in the code i am only able to see two arguement instead of the three mentioned here.
do let me know if it is done intentionally.

Added the correct arguments

Riteshfyi · 2026-01-13T13:17:04Z

packages/contact-center/task/ai-docs/widgets/IncomingTask/ARCHITECTURE.md

+- `accept()` - Accept task handler
+- `reject()` - Reject task handler
+- `isBrowser` - Boolean flag
+


The Parameter isDeclineButtonEnabled is missing here, could i please know is it done intentionally?

Added the correct arguments

Riteshfyi · 2026-01-13T13:17:38Z

packages/contact-center/task/ai-docs/widgets/OutdialCall/ARCHITECTURE.md

+**Returns:**
+- `startOutdial(destination, origin)` - Start outdial function
+- `getOutdialANIEntries()` - Fetch ANI entries async function
+


return {
startOutdial,
getOutdialANIEntries,
getAddressBookEntries,
isTelephonyTaskActive,
};
two parameters are not mentioned above

Added the correct arguments

Riteshfyi · 2026-01-20T12:40:52Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+        H->>H: logger.error('Hold failed')
+    end
+
+    Note over U,B: Resume flow similar with task.resume()


For the Resume scenario, it is appropriate to mention the use of onHoldResume(false)

Riteshfyi · 2026-01-20T12:45:48Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    H->>T: task.consultCall({targetAgentId, destinationType})
+    T->>B: POST /task/consult
+    B-->>T: Consult call created
+    T-->>S: Emit TASK_CONSULT_STARTED


The TASK_EVENT named TASK_CONSULT_STARTED does not appear in the repository, while TASK_CONSULT_ACCEPTED and TASK_CONSULT are present . Please let me know if this was done intentionally.

Updated to the correct version

Riteshfyi · 2026-01-20T12:48:54Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+        H-->>C: Hide timer
+    else Timer reaches 0
+        H->>H: Auto-wrapup triggered
+        H->>H: wrapupCall(null, null, null)


Here we have three arguements instead of two.

Added the correct arguments

Shreyas281299 · 2026-01-14T09:45:34Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+
+## Overview
+
+Provides call control functionality (hold, mute, transfer, consult, conference, end, wrapup) for active telephony tasks. Includes both standard and CAD (Customer Attached Data) variants.


Not just 'telephony tasks', we also have digital tasks

Shreyas281299 · 2026-01-14T09:46:35Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+
+## Why This Widget?
+
+**Problem:** Agents need comprehensive call control during active conversations.


The whole file is more specific for calls but this widget supports call and digital task so we can improve the prompt to be less call specific

Shreyas281299 · 2026-01-14T09:57:54Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+        onHoldResume={(isHeld) => console.log('Hold:', isHeld)}
+        onEnd={() => console.log('Call ended')}
+        onWrapUp={() => console.log('Wrapup complete')}
+        onRecordingToggle={({ isRecording }) => console.log('Recording:', isRecording)}


For all the callbacks, there is task object that is returned. We need to confirm the correct params returned

Added the correct arguments

Shreyas281299 · 2026-01-14T09:58:12Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+```html
+<widget-cc-call-control></widget-cc-call-control>
+<widget-cc-call-control-cad></widget-cc-call-control-cad>


we are removing WC

Shreyas281299 · 2026-01-14T09:59:33Z

packages/contact-center/task/ai-docs/widgets/CallControl/AGENTS.md

+  "@webex/cc-components": "workspace:*",
+  "@webex/cc-store": "workspace:*",
+  "@webex/cc-ui-logging": "workspace:*",


Lets put actual versions

Shreyas281299 · 2026-02-03T04:35:55Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    U->>C: Click Consult button
+    C->>C: Show consult modal
+    U->>C: Select agent
+    C->>H: consultCall(agentId, name, 'AGENT')


Added the correct arguments

Shreyas281299 · 2026-02-03T04:36:00Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    U->>C: Click Conference button
+    C->>C: Show conference modal
+    U->>C: Select agent
+    C->>H: consultCall(agentId, name, 'AGENT')


Added the correct arguments

Shreyas281299 · 2026-02-03T04:36:03Z

packages/contact-center/task/ai-docs/widgets/CallControl/ARCHITECTURE.md

+    C->>C: setSelectedWrapupReason(code)
+
+    U->>C: Click Submit Wrapup
+    C->>H: wrapupCall(reason, id, auxCode)


Added the correct arguments

Shreyas281299 · 2026-02-03T04:36:05Z

packages/contact-center/task/ai-docs/widgets/IncomingTask/ARCHITECTURE.md

+- `accept()` - Accept task handler
+- `reject()` - Reject task handler
+- `isBrowser` - Boolean flag
+


Added the correct arguments

Shreyas281299 · 2026-02-03T04:36:08Z

packages/contact-center/task/ai-docs/widgets/OutdialCall/ARCHITECTURE.md

+**Returns:**
+- `startOutdial(destination, origin)` - Start outdial function
+- `getOutdialANIEntries()` - Fetch ANI entries async function
+


Added the correct arguments

docs(task): add AI documentation for CallControl, IncomingTask, Outdi…

3fc42d9

…alCall, TaskList widgets

Riteshfyi reviewed Jan 13, 2026

View reviewed changes

Riteshfyi reviewed Jan 20, 2026

View reviewed changes

Shreyas281299 added 2 commits February 3, 2026 09:59

docs(task): review comments

1f565d8

docs(task): review-comment

4cbdd65

Shreyas281299 added the validated Indicates that the PR is ready for actions label Feb 3, 2026

Shreyas281299 reviewed Feb 3, 2026

View reviewed changes

Shreyas281299 approved these changes Feb 3, 2026

View reviewed changes

Riteshfyi approved these changes Feb 3, 2026

View reviewed changes

rsarika approved these changes Feb 3, 2026

View reviewed changes

Shreyas281299 merged commit 7be06c9 into webex:next Feb 3, 2026
15 checks passed


		## Overview

		Provides call control functionality (hold, mute, transfer, consult, conference, end, wrapup) for active telephony tasks. Includes both standard and CAD (Customer Attached Data) variants.


		## Why This Widget?

		Problem: Agents need comprehensive call control during active conversations.

docs(task): add AI documentation for CallControl, IncomingTask, OutdialCall, TaskList widgets #577

docs(task): add AI documentation for CallControl, IncomingTask, OutdialCall, TaskList widgets #577

Uh oh!

Conversation

ciscoRankush commented Dec 11, 2025

COMPLETES N/A - Documentation Enhancement

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

Uh oh!

aws-amplify-us-east-2 bot commented Dec 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment